Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Post-release (@getodk/[email protected]) dependency updates & related chores #266

Merged
merged 6 commits into from
Jan 7, 2025

Conversation

eyelidlessness
Copy link
Member

@eyelidlessness eyelidlessness commented Dec 17, 2024

I think the pertinent details are captured in individual commit notes. Top-level, the most notable details:

  • Removes the @getodk/ui-solid package, as we had planned
  • The updates to tree-sitter etc allowed a vast simplification of the @getodk/tree-sitter-xpath package structure, build, etc (as well as nicely paring down top-level git files)

One thing not mentioned in any of the commit notes: we are not currently running the @getodk/web-forms E2E tests in CI! I finally spent a few minutes checking on their status locally, and they're... well, they're broken. I have (and can include in this PR):

  • A complete fix for style.test.ts (it just needs to look for a different text snippet to proceed)
  • A partial fix for vue.test.ts, but it times out. I'm not sure what the best thing is for this test, but it would probably be best if we can break it up into per-fixture tests (probably requiring codegen possibly solvable with Playwright's concept of fixtures).

This package has outlived its usefulness. We removed it from CI in #261, anticipating full removal of the package in a more appropriately scoped PR.

Note: the `yarn.lock` change is a result of running `yarn install` immediately after all of the other changes in this commit.
Manually verified on 22.12.0 (in case `tree-sitter` et al have issues):

- clean install
- monorepo-wide build
- monorepo-wide test (partial run of flaky `web-forms` e2e tests, accepting that they were already flaky and shouldn’t be otherwise affected by this change)
Copy link

changeset-bot bot commented Dec 17, 2024

⚠️ No Changeset found

Latest commit: 70fb0fb

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@eyelidlessness
Copy link
Member Author

eyelidlessness commented Dec 17, 2024

  • Looks like I have some new lint issues to address 🙃

This change updates tree-sitter and related dependencies, and accounts for the current iteration of churn in various special case details of how a tree-sitter project is supposed to work. On the bright side, it turns out things got a lot simpler this time!

- The structure of the `@getodk/tree-sitter-xpath` package is now much more like the other packages. This is largely because the assumptions made by `tree-sitter-cli` are based around a special `tree-sitter.json` file, rather than overloading `package.json` with tree-sitter specific details.

- We no longer (need to) build for Node. Since all of our downstream packages consume the parser as WASM, we benefit from a simpler and (MUCH) faster build step. Note that this may technically be a breaking change (though I’m not sure that it is, since I’m pretty sure we never published the Node bindings, even when they were built).

- Many of the extraneous build artifacts are no longer produced, either because they’re excluded in `tree-sitter.json` or because we are no longer building for Node at all. This allows us to significantly scale down custom build scripting, as well as tree-sitter specific entries in .gitignore/.gitattributes.

- The `tree-sitter` internal build tooling no longer uses `nan`, which also allows us to remove `nan` and `node-gyp` dependencies, and in so doing eliminates another often-fussy thing to check in post-release dep updates.
…ce package

This makes it much easier to run monorepo-wide commands. (I have made this change locally a zillion times to speed up tasks like this one, and it’s never cause a problem. I don’t know what the future for the `scripts` package should be, I’d prefer it go away eventually! But for now it seems reasonable to just remove it here.)
* The following have been skipped, or held back to a semver-minor update:

- Across all packages: Vite has been updated to the latest (presumably last) 5.x.x release, rather than the semver-major update to 6.x.x. I didin’t even bother trying Vite 6, because Vitest won’t support it until January ([source](https://github.com/vitest-dev/vitest/releases/tag/v3.0.0-beta.1)).

    As with previous dependency updates, I have manually prodded Yarn to use the same version of Vite for Vitest’s transitive dependency. How it’s done (every time, but feels worth documenting):

        1. Update direct `vite` dependencies in each affected `package.json`

        2. `yarn install`

        3. Delete the older entry for `vite` in `yarn.lock` (I always spot check that it’s the same one associated with `vitest`, it is also usually associated with `vite-node`.)

        4. `yarn install` again, to update the lockfile so both `^`-range references point to the same version again. (In theory I could make that change manually and then just run `yarn install` again to verify, but I trust the lockfile generation logic more than my typing skills.)

- `@getodk/web-forms`-specific:
    - Vue has been pinned to 3.3.4, consistent with the current version used by Central. (Periodic reminder that we cannot update this until Central does; also we should consider what this means for other potential Vue-based integrations!)
    - PrimeVue &co have not been updated, pending updates to this package coinciding with those upgrades
@eyelidlessness eyelidlessness force-pushed the postrelease/060-dep-updates branch from 5af3da8 to 70fb0fb Compare December 18, 2024 17:59
Copy link
Member

@lognaturel lognaturel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's ok to get the E2E test running in CI in its own PR but don't feel strongly either way.

@eyelidlessness eyelidlessness merged commit 4b31432 into main Jan 7, 2025
74 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants